BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / doors_2 / tyahtz50.zip / YAHTZEE.DOC < prev next >

Wrap

Text File | 1992-09-25 | 22KB | 494 lines

TRIPLE YAHTZEE v5.0 by Al Lawrence Sunrise-80 BBS (404) 256-9525 OVERVIEW ________ Triple Yahtzee is played exactly like the board game. A high score file is maintained (size is controlled from the configuration file). Since this game can take a while to play to completion, a game save feature has been included. This feature allows the caller to save the game contents and return to the same game on their next call automatically. NOTE: Most errors will be logged to a file called DFRAME.ERR, which is created in the directory you run the door from. INSTALLATION ____________ Installation is fairly easy and straight-forward. The following steps and examples should have you up and running in a very short period of time. It is assumed that you are familiar with setting up DOORS on your system. To this end, only examples of the configuration file and Door batch file are described. 1) Create a directory to hold all YAHTZEE files 2) Unzip TYAHTZxx.ZIP into the the above directory NOTE: BRUN45.EXE is not included but is required !!! 3) Create a configuration file, with a name of your choice, or modify the supplied YAHTZEE.CFG file. A description follows: ** Location of System file SUNRISE-80 BBS Your BBS Name Al SYSOP's First Name Lawrence Sysop's Last Name |-----------------------------------------------------------------------------| | READ! 1 CommPort \ These 2 lines are required | | READ! 1 Node # / ONLY for GTUSER.BBS | |-----------------------------------------------------------------------------| 00000000 Registration Number 50 Number of Top Score entries. Minimum = 10, Maximum = 99. # 2 Keyboard timeout value in minutes. If key not depressed for 2 minutes board is saved and caller is returned to BBS. Minimum=2, Maximum=5 # NONE Drive:\Path\Filename to contain the Top Score Bulletin or enter NONE for NO Bulletin creation. # NONE Drive:\Path\Filename to contain the Top Score Bulletin (Color) or enter NONE for NO Bulletin creation. 1 Initial setting of the HOTKEY feature. 1=ON, 0=OFF. Default will be 1 if any other value is encountered. 2 1 = DO NOT Display the ADOPT-A-DOOR Msg 2 = DO Display the ADOPT-A-DOOR Message When YAHTZEE is Registerd, this option will have no effect. This option is for those Sysops that do not like the ADOPT-A-DOOR Concept. # 1 Color of Main Portion of Board 1=Blue, 4=Red, 5=Magenta, 14=Yellow 2 1=Caller will appear only one time in the HiScore file 2=Caller can appear any number of times in then Hiscore file ! # 1 Number of games allowed each day (Sysop gets 99 in registered version ONLY!) ! # 0 Time Allowed in Door (0 = BBS call time remaining) (Sysop = Time Remaining - REG. VERSION) ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day ! # 000=00/00 Security Level/Games Allowed Per Day @ # XXXX/YYYY Blackout Range From/To @ # XXXX/YYYY Blackout Range From/To @ # XXXX/YYYY Blackout Range From/To @ # XXXX/YYYY Blackout Range From/To @ # XXXX/YYYY Blackout Range From/To ** = Replace with ONE of the following: C:\PCB\PCBOARD.SYS <- For PCBoard systems using PCBOARD.SYS only C:\BBS\CALLINFO.BBS <- For Wildcat! systems (prior to v3.0) C:\BBS\USERINFO.DAT <- For Wildcat! systems using v3.x (Note:DOOR.SYS must be in SAME directory) C:\BBS\DOOR.SYS <- For ANY systems that support DOOR.SYS C:\BBS\DORINFOx.DEF <- For ANY systems that support DORINFOx.DEF C:\BBS\SFDOORS.DAT <- For Spitfire systems. c:\bbs\TRIBBS.SYS <- For TriBBS systems. C:\BBS\CHAIN.TXT <- For WWIV systems C:\BBS\GTUSER.BBS <- For GT Power * if using this option you must put the ComPort # on line 5 and the Node # on line 6 of the configuration file # = Requires registration to change to a different value ! = See "Plays Per DAY/DOOR Time" Below @ = See "Blackout Periods" Below 4) Create a batch file or modify the YAHTZEE file supplied. A description of this file follows: ECHO off cd\PCB\DOORS\YAHTZEE Location of Yahtzee files YAHTZEE YAHTZEE.CFG EXE filename and CFG filename (Name used in creating file in #3 above) CD\PCB BOARD 5) When running in more than one node, be sure to supply a different configuration name for each node (your choice of name). BLACKOUT PERIODS ________________ Use the Blackout ranges option to define up to 5 time periods during which you DO NOT want the Door to be played. If a caller tries to access the Door during the Blackout period, they will be shown a message that contains ALL the Blackout periods you have defined, and to try the Door at a later time. Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where XXXX=beginning time and YYYY=the ending time. For example, 0930/1230 means to NOT allow the Door to be played between 9:30am and 12:30pm. IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format - DO NOT change the XXXX/YYYY entry UNLESS you want to assign a Blackout range. - You MUST use the MILITARY time format. Example: 2030=8:30pm 0900=9am, 0030=12:30am, 1700=5pm, etc. NOTE: There should be NO BLANK LINES in the configuration file! PLAYS Per DAY/DOOR Time _______________________ Plays Per Day and Door Time can be controlled several ways: (1) You can use the Games Per Day, singular option, in the config file above. This option, will affect ALL callers whose Security Level is NOT defined in any of the 10 optional Security Level/ Plays Per Day entries in the config file. (2) You can use the Door Time, singular option, in the config file above. This option, will affect ALL callers whose Security Level is NOT defined in any of the 10 optional Security Level/ Plays Per Day/Door Time entries in the config file. (3) You can restrict the number of games a specific Security Level will be allowed to play per day or REWARD specific Levels with more Plays Per Day. Likewise, you can restrict the Play time for a specific Security Level or REWARD specific Levels with more Door Time. These options are handled by the use of the 10 config entries (000=00/00). The format of each entry is as follows: XXX=YY/ZZ where XXX is the Security Level (must be 3 digits) where = is a constant and MUST be included where YY is the # of games per day (must be 2 digits) where / is a constant and MUST be included where ZZ is num. minutes per Door entry (must be 2 digits) If the callers Security Level is NOT defined, his/her Plays Per Day and Door Time will be controlled by the values in items (1) and (2), above, respectively.. You may define up to 10 Security Levels. All unused entries must be defined as 000=00/00 -------------------------------------------------------------------- Example: Suppose you had 3 Security Levels defined on your BBS as (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you wanted to set Plays Per Day as : Subscriber=5 Visiting Sysop=2 CoSysop=3 Friend=10 and Door Time as follows: Subscriber=30 minutes Visiting Sysop=20 minutes CoSysop=10 minutes Friend=remaining call time You would set the Individual "Games per Day" config entry to 1 and the individual "Door Time" to 5 minutes (these would be the default number of games and default Time for all Security Levels other than 20,30 or 40... make them any number you want). Next you would replace 4 of the Security Level entries as : 020=05/30 030=02/20 040=03/10 090=10/0 NON-STANDARD COM SUPPORT ________________________ Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ number after the configuration filename. Let's assume your Door is called FOOBAR and you want to use COM1 and IRQ5. The command line passed to your Door would be: FOOBAR FOOBAR.CFG /5 The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is normally used with COM1. No /x parameter is needed for the standard IRQ's. As an alternative, you may use an environmental variable on the command line. To use the variable (following the example above), place a SET IRQ=5 in the batch file used to bring up your BBS (you would need a different IRQ number for each node). The command line would now look like this: FOOBAR FOOBAR.CFG /%IRQ% This, in combination with the use of the environmental variables described in the MULTI-NODE SETUP section will allow you to use one batch file and one config file to run this door on all nodes. MULTI-NODE SETUP ________________ All Sunrise Doors are Multi-Node capable. Each node must have the ability to access a configuration file which will have its own system file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first line. There are 2 ways to accomplish this: (1) Create a separate configuration file for each node. The only difference between each file would be the location of the system file for that particular node. For example, on my system there are 2 nodes and the first line of the config files would look like this: NODE1: H:\PCB1\DOOR.SYS NODE2: H:\PCB2\DOOR.SYS Thus, if you have a 4 node BBS, you will need 4 configuration files. (2) Use ONE configuration file for ALL nodes. This Door will recognize the following PCBoard environmental variables: PCBDIR (Directory containing the System file) PCBDRIVE (Drive containing the System file) Thus, the first line of the SINGLE configuration file, for this Door would look like this: %PCBDRIVE%%PCBDIR%\DOOR.SYS NOTE: This option, as described, assumes that you are running PCBoard 14.5a software. The environmental variables are automatically created by the software for each node. HOWEVER, if you are running other BBS software you should be able to set the variables EXACTLY as described below, for EACH node (more than likely in each batch file you use to bring up EACH node): PCBDRIVE=C: ^^^^^^^^^ PCBDIR=\NODE2 ^^^^^^^^ Info with a carat (^) under it, MUST be typed as is. The rest depends on your naming conventions. This, in combination with the use of the optional environmental variable described in the NON-STANDARD COM SUPPORT section, will allow you to use one batch file and one config file to run this door on all nodes. UPLOADED SCORE UPDATING(PC-YAHTZEE) ___________________________________ Triple Yahtzee's companion program, PC-YAHTZEE, is used by your callers to play Triple Yahtzee offline on their PC's. When they register PC-YAHTZEE, they unlock the ability to upload their scores to your BBS. You in turn combine all uploaded scores and merge them into your BBS' Triple Yahtzee high score file. You have the option to implement this feature or not. Your callers will be uploading numeric filenames with .UPL as the extension (ex: 12345678.UPL). You can have them upload them to a private upload directory or to your regular upload directory. If you choose the regular upload directory, then be sure you allow uploads with a .UPL extension. The uploaded filename is a fixed format, unique to each user of PC-YAHTZEE. Be sure to let your callers know how/where to upload their Yahtzee High Score files ! I would appreciate your posting the latest PC-YAHTZEE program as I believe it will benefit the throughput of your board, by reducing the amount of time spent playing Triple Yahtzee. Please be sure to download a copy for yourself and POST one on your BBS!!! Should you decide to implement (and I would suggest that you do), use the following batch file (modify where appropriate) to automate this updating process. (1) D: (2) CD\NEWUPLD (3) COPY *.UPL YAHTZEE.CMB (4) DEL *.UPL (5) COPY YAHTZEE.CMB C:\PCB\DOORS\YAHTZEE3\ (6) DEL YAHTZEE.CMB (7) C: (8) CD\C:\PCB\DOORS\YAHTZEE3 (9) YAHTZMRG YAHTZEE.CFG (10) DEL YAHTZEE.CMB (1) Change to D: drive (2) Change to directory containing the uploaded score files (3) Merge all .UPL files into YAHTZEE.CMB (DO NOT rename YAHTZEE.CMB !!!) (4) Delete uploaded files (*.UPL) (5) Copy YAHTZEE.CMB to Triple Yahtzee door directory (6) Delete YAHTZEE.CMB from upload directory (7) Change to C: drive (8) Change to Triple Yahtzee door directory (9) Merge uploaded scores with YAHZTEE.SCO file(Use Yahtzee config file) (10) Delete YAHTZEE.CMB NOTE: This can be run in a nightly event process!! When merging, YAHTZMRG.EXE will reject duplicate entries within the uploaded file(s) as well as entries that duplicate existing entries in the YAHTZEE.SCO file. The uploaded score file(s) are created by PC-YAHTZEE. Any attempt to change these scores with an editor will result in YAHTZMRG rejecting them outright. ADOPT-A-DOOR ____________ Having been a Sysop for a number of years, I have had my share of problems and frustrations getting financial support for my board's upkeep. A fellow Sysop left a message on my board, not long ago, about a concept that was being used by several boards around the country. The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It would be the same as sending in a donation, only this way it is earmarked for registering a particular door. In a way, the user feels he/she is "getting something in return". As a Door author I have decided to build this concept into each of my Door programs. The concept replaces the usual message "tell the Sysop to register this Door" we find in most doors. If the Door is unregisterd then a message appears on the opening screen to that effect. After finishing or suspending a game, a message screen is displayed about the ADOPT-A-DOOR concept. The message also tells the caller to contact the Sysop to find out if there is any further details to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online time, etc to callers that ADOPT-A-DOOR. If the Door has been registered, either by the Sysop or other callers, the names of those contributors will be displayed in the closing screen. NOTE: If you want to display the names of the callers that contributed to registering the Door, you must create an ASCII file called ADOPT.SYS. You create it with an Editor or Word Processor. Enter the name(s) of the contributors (one on each line, maximum of 5 entries, each a maximum of 30 characters long). This file must be saved, in ASCII format, and placed in the Door directory. LEGALITIES __________ THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY. DISTRIBUTION ____________ You may make this file available for downloading from your BBS or you may upload it to any BBS of your choice, provided that you do not make any changes to the contents of the archive (ZIP file). The archive and its individual contents may not be used by any service that charges any money whatsoever, without the written permission of the author. REGISTRATION ____________ Registration and the subsequent insertion of the registration number into your configuation file, allows for the display of your BBS name on the opening and closing screen as well as the reduction of a delay built into the opening screen display along with the ability to change certain values in the configuration file. To register your copy of YAHTZEE, please fill out the registration form (REGISTER.FRM) and mail it along with the registration fee to the name and address on the form. Be sure to use the proper upper/lower case when filling in your name and BBS name, as they MUST match the way you entered them in the configuration file. ^^^^ Based upon information supplied on the registration form, I will pre- register you on my BBS. You will then be able to call SUNRISE-80 and pick up your registration number or supply a self-addressed stamped envelope. MISC ____ The latest version of TRIPLE YAHTZEE and other fine SUNRISE DOOR programs are always available for download from SUNRISE-80 BBS and/or SALTAIR BBS. Remember, should you have any problems, questions or suggestions, be sure to drop me a message on either of the aforementioned BBS' or via the DOORS conference on PCRELAY/RIME, Node=SUNRISE.